docs: focus README on safe cache rollouts - #89
Open
lan17 wants to merge 10 commits into
Open
Conversation
24 tasks
lan17
force-pushed
the
docs/readme-safety-adoption
branch
2 times, most recently
from
July 26, 2026 00:27
3d14c88 to
09d3ee5
Compare
lan17
force-pushed
the
docs/readme-safety-adoption
branch
from
July 26, 2026 03:04
09d3ee5 to
4a2dc71
Compare
lan17
marked this pull request as ready for review
August 4, 2026 01:53
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mainwith a 2,918-word adoption guide that identifies DialCache as a TypeScript read-through caching library before introducing its production patternscached()or keep a loader inline withgetOrLoad(); after active layers miss, DialCache calls the application loader and publishes to active request-local, bounded process-local, and optional Redis or Valkey layersdocs/is not part of the package tarballWhy
The current README is technically thorough but makes experienced backend engineers work too hard to establish the basic mental model: what kind of cache this is, what happens on a miss, which layers it manages, which high-scale patterns it adds, and which infrastructure and safety decisions remain application-owned.
The revised README answers those questions before setup, gives a copyable local-only quick start, then shows the path from local verification to a safe production rollout. Detailed contracts remain available without turning the README back into the full reference manual.
Current-main refresh
This branch now includes current
mainthroughv0.19.0plus the Redis-write benchmark update, and documents the public behavior added since the priorv0.14.1refresh:v0.15.0upgrade considerationcoalesce: falseopt-out, independent reads/deadlines/writes, observability effects, and thundering-herd tradeoffGETand atomic trackedMGETreads, including authoritative routing requirements and stale-payload transferSETand tracked placeholder-plus-stamp writes, including nonce safety, ambiguity, placeholder-loss errors, adapter lifecycle, ACLs, and current protocol exportsCONFIG RESETSTATsafety requirementsImpact
This is documentation-only relative to current
main.Merging this PR will not republish
v0.19.0; the rewritten README will appear on npm with a future package release. Its absolute links will resolve to the merged reference guides onmain.Validation
corepack pnpm checkunder Node.js 22.22.0 — strict typecheck, 512 unit tests with coverage, builds/declarations, and packed ESM/CJS consumerscorepack pnpm test:integration— suite passed with 139 cases collected (137 passed, 2 environment-skipped)corepack pnpm benchmark:request-local— all ten semantic scenarios passedcorepack pnpm benchmark:redis-writeagainst a disposable Redis 6.2 — all eight tracked/untracked size configurations completedgit diff --check